home *** CD-ROM | disk | FTP | other *** search
/ PD Collection CD 1 / PD Collection CD 1.iso / comms / riscbbs / !RiscBBS / BBS / Bulletin < prev    next >
Text File  |  1991-11-14  |  4KB  |  103 lines
  1. {abort 1 attr 0 6 report `Reading bulletin`}
  2. Small document with the ArcANSI module
  3. --------------------------------------
  4.                                                   
  5. Some facts:
  6. -----------
  7. ArcANSI is the Archimedes ANSI Escape Sequence emulator module.
  8. ANSI escape sequences are sequences of bytes that allow for easy colour
  9. and cursor control. All sequences start off with a 27 (ESC), hence the 
  10. term 'escape sequences'.
  11. The ANSI 6429 standard is mostly used by BBS's to give their users nice
  12. and colourful screens in a quick and widely supported way!
  13. People familiar with MS-DOS surely know about ANSI.SYS... ArcANSI is just
  14. the Archimedes equivalent of this ANSI.SYS driver!
  15.  
  16.  
  17. The ANSI 6429 escape sequences:  
  18. -------------------------------
  19. Note that ESC must be treated as the single byte 27!
  20.  
  21. ESC[r;cH         | Put cursor at position r,c (ROW,COLUMN)
  22. ESC[r;cf         | E.g. ESC[10,16H                  
  23.  
  24. ESC[nA           | Move cursor up n lines (omitting n moves up 1 line)
  25.                  | E.g. ESC[4A
  26.  
  27. ESC[nB           | Move cursor down n lines (omitting n moves down 1 line)
  28.                  | E.g. ESC[10B
  29.  
  30. ESC[nC           | Move cursor right n columns (omitting n moves right 1 col)
  31.                  | E.g. ESC[C
  32.  
  33. ESC[nD           | Move cursor left n columns (omitting n moves left 1 col)
  34.                  | E.g. ESC[3D
  35.  
  36. ESC[s            | Store current cursor position
  37.                  | E.g. ESC[s
  38.  
  39. ESC[u            | Restore previously stored cursor position
  40.                  | E.g. ESC[u
  41.  
  42. ESC[2J           | Clear display and move cursor to home position
  43.                  | E.g. ESC[2J
  44.  
  45. ESC[K            | Clear current line from cursor position (inclusive)
  46.                  | E.g. ESC[K
  47.  
  48. ESC[c;...;cm     | Set foreground/background colours                
  49.                  | 0 = reset to default colours (white on black)
  50.                  | offset 0 = black
  51.                  | offset 1 = red
  52.                  | offset 2 = green
  53.                  | offset 3 = yellow
  54.                  | offset 4 = blue
  55.                  | offset 5 = magenta
  56.                  | offset 6 = cyan
  57.                  | offset 7 = white
  58.                  | To set foreground colour, add 30 to colour offset
  59.                  | To set background colour, add 40 to colour offset 
  60.                  | E.g. ESC[34;47m
  61.  
  62.  
  63. Using ArcANSI:
  64. --------------
  65. To load the ArcANSI module, double-click on its icon in a filer, or type
  66. '*RMLoad ArcANSI [ENTER]' at the CLI-prompt * .
  67. When loaded, the emulator will automatically activate itself, ie. any bytes
  68. subsequently sent to the VDU will pass through the ANSI emulator, which will
  69. take action when necessary.                                                 
  70.  
  71. The module also provides the new *ANSI keyword:
  72. Use  '*ANSI Off [ENTER]'  to turn the ANSI emulator off
  73.      '*ANSI On  [ENTER]'  to turn the ANSI emulator back on
  74.      '*ANSI     [ENTER]'  to display the ANSI emulation status
  75. Use  '*Help ANSI_Info [ENTER]'  for some cryptic info on the ArcANSI module.
  76.  
  77. The module also provides a new SWI, "ANSI_Control" (&C0100):
  78. Entry: R0 = 0, R1 = 0
  79.        Turn off the ANSI emulator
  80. Entry: R0 = 0, R1 = 1
  81.        Turn on the ANSI emulator
  82. Entry: R0 = 1, R1 = 0
  83.        Don't allow VDU codes to pass through the emulator
  84. Entry: R0 = 1, R1 = 1
  85.        Allow VDU codes to pass through the emulator
  86.  
  87.  
  88. Comments:
  89. ---------
  90. If you have any comments on the ArcANSI module or would like to get some more
  91. info on BASS, write to:
  92.  
  93.         Carl Declerck, Vrijgeweidestraat 24, 2800 Mechelen, Belgium
  94.                                     or
  95.        John Tytgat, Brusselbaan 445, 1600 St.-Pieters-Leeuw, Belgium
  96.  
  97.  
  98.                        Tune in, Turn on, Burn out...
  99.  
  100.                                                     Carl Declerck, BASS 1990
  101.  
  102. {show <RiscBBS$Dir>.BBS.AnyKey}
  103.